modifySchedule

Performs individual schedule updates in MusicMaster. You can use this command to change one or more elements. This would generally be used to drop or insert song, or a more complex move or swap operation. You can also use this command to change non-music element types and element properties.

Sample Request

<mmRequest command="modifySchedule" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
		<changes>
			<change>
				<target airTime="" [class=""] [historyId=""] [runTime=""] [songId=""] [cutId=""] />
				<action mode="add|drop|modify|move" [pos="before|after|replace"] [airTime=""] [runTime=""] [class=""] [songId=""] [cutId=""] [historyId=""] [category=""] [sweep=""] [text=""] [mergeStart=""] [mergeEnd=""] [mergeCode=""] [markType=""] [markMinTime=""] [markMaxTime=""] [markResetTime=""] [markReset=""] [properties=""] [transition=""] [user1=""] [user2=""]/>
 <showInstance showName="Show Name Text" identification="" rerun="[0/1]" episode="" startTime="0:00" length="0:00">
 <metadata property="">value</metadata>
</showInstance>
			</change>
		</changes>
	</contents>
</mmRequest>

Request Notes

The changes section contains the actual change(s) you wish to perform. Each will contain a child tag with the target element where you wish to make the change, and the action you wish to perform on that element. You should only include the required attributes and the optional ones that you actually need.

 

The following attributes are available for the change target tag:

 

airTime – indicates that starting time that the element aired or is scheduled to air. This is required for every request and is used to determine which hour the desired element is located in. You can narrow down the search for your target element and make a more exact match by using one or more of the additional optional properties that follow. Starting with MusicMaster PRO 5.0 SR-3, this is optional when you also specify a valid value in the historyId property. In that case the historyId value will be used to determine the hour containing the desired element. If you only specify airTime, it will find the scheduled element closest to that airTIme, regardless of what it is.

 

historyId – the MusicMaster History ID of the element, if known. This can be obtained using and is the most exact way to target a specific element. If a valid History ID is specified, this will be used to determine which hour the desired element is located in. (Changed in 5.0 SR-3). If the historyID does not exist, you will get an element not found message and the other properties are ignored.

 

class – indicates the type of element you are searching for.

  • L=Lognote
  • M=Scheduled Music
  • T=Traffic Merge
  • U=Unscheduled Fixed Category
  • W=Show Marker
    • To create an End Show marker, you omit the Show information: <action mode="modify" class="W"/> or <action mode="modify" class="W"> <showInstance/> </action>
  • *=Timing Checkpoint
  • runtime – indicates the actual schedule run length of the element you are searching for.
  • songId – the MusicMaster Song ID of the element, if known. airTime must be specified when using this. A search will be done in the hour specified looking for a scheduled song that matches the songID. If there is more than one, it will find the one closes to the airTime. If none are found, you will get an element not found message. When songID is specified, cutID is ignored.
  • cutId – the element ID from the third party system, if known. airTime must be specified when using this. A search will be done for the cutID to find the matching element. If there is more than one match, it will find the one with the lowest songID. If none are found, you will get an element not found message.

 

action

The following attributes are available for the change action tag:

mode=

Indicates the type of change for this element: add, drop, modify and move are currently supported. This is required.

  • Add - If no runtime is specified when adding a new song to the log, the song runtime is always used by default.
  • Move - With the move option, you are targeting an element to move it before, after or to replace the source. This eliminates the need to do two commands to delete one element and move a second. When used the historyID of the element will not change.
pos= Indicates the relative position to the specified element for an add operation. You can replace the specified element, or insert an element just before or after it. (before|after|replace). Replace is the default value if not specified.
airTime=

Indicates that starting time that the element aired or is scheduled to air. This is only used for add operations. (mm:ss)
class=

The type of element you wish to add. You can also use this to change an existing element to a different type. You must specify the class if you are changing it to something different from the current value.

  • L=Lognote

  • M=Scheduled Music

  • T=Traffic Merge

  • U=Unscheduled Fixed Category

  • W=ShowMarker

  • *=Timing Checkpoint
historyId= The MusicMaster History ID of the element, if known. This can be obtained using and is the most exact way to target a specific element.

Additional properties are available based upon the type of element you are modifying

These are based upon the value of the class property:

ATTRIBUTE PURPOSE VALID CLASSES        
    M U L T W *
category= Category code (not the numeric ID)   X        
comment= This is simply a comment about an entry. It can be useful as an indicator before other data. To clear the comment, you can use the format of comment="" If you do not with to change the value or clear it, this tag should not be included. X X X X    
cutID= Element ID from the third party system for the new song X          
markReset=

Indicates where the forced airtime should be reset. You can turn each individual property on or off by specifying the letter code preceded by a plus or minus symbol.
+L - Reset for Log Export on

-L - Reset for Log Export off

+P - Reset for Play History on

-P - Reset for Play History off

+R - Reset Rolling Time on

-R - Reset Rolling Time off

           X
markMaxTime= Earliest acceptable airtime for a tested checkpoint (mm:ss)           X
markMinTime= Earliest acceptable airtime for a tested checkpoint (mm:ss)           X
markResetTime= Forced reset airtime for a timing checkpoint           X
markType= This is the type of timing checkpoint (‘hour’, ‘sweep’, ‘none’)           X
mergeCode= mergeCode Merge code for spot catching X       X    
mergeEnd= End time for spot catching (mm:ss)       X    
mergeStart= Start time for spot catching (mm:ss)       X    
metdataproperty= This is a sub-property of showInstance that lists the metadata property assigned to the Show         X  
properties=

This is used to adjust the element properties of any element. If not included, the existing properties will not be changed. You can turn each individual property on or off by specifying the letter code preceded by a plus or minus symbol.

+E - Hide from Export on

-E - Hide from Export off

+L - Element Locked

-L - Element Unlocked

+P - Hide from Printing on

-P - Hide from Printing off

+R - Hide from Reconciliation on

-R - Hide from Reconciliation off

 X X X X    
runTime= Runtime of the element you are adding or changing. When modifying an existing element the existing runtime will remain if not specified here (mm:ss) X   X X    
showInstance= This is used to specify the Show. This can be done with the showName tag. You can also have a sub-tag of metadataproperty where you indicate the metadata value.         X  
showName= This is the name of the Show. This name is important when performing an update. If it does not match the existing element exactly, the Show will be replaced by a new instance of the named Show. If it matches, the existing instance will be updated. You can force it to do an update without concern for the name by omitting this attribute from your request. It is only compared if it is provided.         X  
songID= MusicMaster Song ID of the element, if known for the new song X          
sweep= Used to indicate whether the element should act as a sweep marker     X X   X
text= The actual text for a lognote (255 char max)     X      
transition= This is used to adjust the transition code element property on any element. If not included, the existing transition code will not be changed. To clear the transition, you can use the format of transition="" If you do not with to change the value or clear it, this tag should not be included. X X X X    
user1=, user2= These are used to adjust user note fields that are associated with schedule elements. To clear the user1 or user2, you can use the format of user1="" or user2="" If you do not with to change the value or clear it, this tag should not be included. X X X X    

Notes

When searching for an element by airtime only, the element selected will be the first one from the start of the hour that is scheduled to start at the specified airtime, or the one that starts before and runs through the specified airtime.

 

Performance and accuracy can be improved by using the historyId attribute for the target element and the songId attribute when adding or changing music elements.

Sample Reply

<mmReply command="modifySchedule" station="ID" version="1" [userData=""] status="???????">
	[<errors>
		<error>message</error>
	</errors>]
	[<results>
		<result [mode] [songId] [historyId] status="ok|error"></result>
	</results>]
</mmReply>

Reply Notes

This command does not return any schedule data. Instead, the server performs the reconciliation and returns a status code and any error messages. If a non-generic interface is in use, the method used to reconcile the schedule may vary.

Compatibility and Version Info

Available in MusicMaster PRO 4.0sr19 and later

 

Starting with MusicMaster PRO 5.0sr3, the airTime property is no longer required when you have the history ID of the element you wish to change. It is recommended that you still specify an air time for compatibility with older versions. The history ID value will now take precedence over the specified airtime. [5001]

 

Added the results section to the reply message in MusicMaster PRO 5.0sr3. [5001]

 

Added the ability to create and modify timing checkpoint elements in MusicMaster PRO5.0sr16 [5008]

 

showInstance details added with MusicMaster CS 3.0

showList property details added with MusicMaster CS 3.0